Inside Macintosh: QuickDraw GX Objects /

Chapter 5 - Ink Objects / Ink Objects Reference

Functions / Getting and Setting an Ink's Transfer Mode

GXSetShapeTransfer

You can use the GXSetShapeTransfer function to assign a transfer mode to the ink object associated with a shape.

void GXSetShapeTransfer(gxShape target, const gxTransferMode 
*data);

target

A reference to the shape whose ink object you want to assign the transfer mode to.

data

A pointer to a transfer mode structure containing the transfer mode to assign to the shape's ink.

DESCRIPTION

The GXSetShapeTransfer function assigns the transfer mode pointed to by the
data parameter to the ink object associated with the shape referenced in the target parameter.

Calling this function is almost equivalent to:

GXSetInkTransfer(GXGetShapeInk(myShape),theMode);

except that, if the source shape's ink object is shared with other objects, GXSetShapeTransfer creates a new copy of that ink object and assigns it to the shape before changing its transfer mode. That way, calling this function does not produce any side effects on other shapes.

SPECIAL CONSIDERATIONS

The color space of the transfer mode pointed to by the data parameter cannot be gxNoSpace or any of the packed color spaces (such as, for example, gxRGB16Space). If you specify gxHighlightMode in some but not all components of the transfer mode, this function posts an inconsistent_parameters error.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
shape_is_nil
transferMode_is_nil
parameter_out_of_range	(debugging version)
inconsistent_parameters	(debugging version)
invalid_transferMode_colorSpace	(debugging version)
colorSet_access_restricted	(debugging version)
colorSpace_out_of_range	(debugging version)
colorProfile_access_restricted	(debugging version)

SEE ALSO

Transfer modes are described in the sections "About Transfer Modes" beginning on page 5-11, and "Working With Transfer Modes" beginning on page 5-44.

To examine the transfer mode of the ink object associated with a shape, use the GXGetShapeTransfer function, described in the previous section.

To assign a transfer mode to an ink object directly, use the GXSetInkTransfer function, described on page 5-73.

The GXGetShapeInk function is described in the chapter "Shape Objects" in this book.

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help